package org.dromara.generator.domain;

import com.baomidou.mybatisplus.annotation.FieldStrategy;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotBlank;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.dromara.common.core.utils.StringUtils;
import org.dromara.common.mybatis.core.domain.BaseEntity;
import org.dromara.generator.constant.GenConstants;

import java.util.List;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：业务表 gen_table
 */
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("gen_table")
public class GenTable extends BaseEntity {

    /**
     * 编号
     */
    @TableId(value = "table_id")
    private Long tableId;

    /**
     * 数据源名称
     */
    @NotBlank(message = "数据源名称不能为空")
    private String dataName;

    /**
     * 表名称
     */
    @NotBlank(message = "表名称不能为空")
    private String tableName;

    /**
     * 表描述
     */
    @NotBlank(message = "表描述不能为空")
    private String tableComment;

    /**
     * 关联父表的表名
     */
    private String subTableName;

    /**
     * 本表关联父表的外键名
     */
    private String subTableFkName;

    /**
     * 实体类名称(首字母大写)
     */
    @NotBlank(message = "实体类名称不能为空")
    private String className;

    /**
     * 使用的模板（crud单表操作 tree树表操作 sub主子表操作）
     */
    private String tplCategory;

    /**
     * 生成包路径
     */
    @NotBlank(message = "生成包路径不能为空")
    private String packageName;

    /**
     * 生成模块名
     */
    @NotBlank(message = "生成模块名不能为空")
    private String moduleName;

    /**
     * 生成业务名
     */
    @NotBlank(message = "生成业务名不能为空")
    private String businessName;

    /**
     * 生成功能名
     */
    @NotBlank(message = "生成功能名不能为空")
    private String functionName;

    /**
     * 生成作者
     */
    @NotBlank(message = "作者不能为空")
    private String functionAuthor;

    /**
     * 生成代码方式（0zip压缩包 1自定义路径）
     */
    private String genType;

    /**
     * 生成路径（不填默认项目路径）
     */
    @TableField(updateStrategy = FieldStrategy.NOT_EMPTY)
    private String genPath;

    /**
     * 主键信息
     */
    @TableField(exist = false)
    private GenTableColumn pkColumn;

    /**
     * 表列信息
     */
    @Valid
    @TableField(exist = false)
    private List<GenTableColumn> columns;

    /**
     * 其它生成选项
     */
    private String options;

    /**
     * 备注
     */
    private String remark;

    /**
     * 树编码字段
     */
    @TableField(exist = false)
    private String treeCode;

    /**
     * 树父编码字段
     */
    @TableField(exist = false)
    private String treeParentCode;

    /**
     * 树名称字段
     */
    @TableField(exist = false)
    private String treeName;

    /*
     * 菜单id列表
     */
    @TableField(exist = false)
    private List<Long> menuIds;

    /**
     * 上级菜单ID字段
     */
    @TableField(exist = false)
    private String parentMenuId;

    /**
     * 上级菜单名称字段
     */
    @TableField(exist = false)
    private String parentMenuName;

    /**
     * 判断当前对象是否为树结构
     * 此方法主要用于确定当前模板分类属性是否指示一个树形结构
     * @return 如果当前对象的模板分类属性指示一个树形结构，则返回true；否则返回false
     */
    public boolean isTree() {
        return isTree(this.tplCategory);
    }

    /**
     * 判断模板类型是否为树结构类型
     *
     * @param tplCategory 模板分类，用于标识模板的类型
     * @return 如果模板分类不为空且等于树结构类型的常量，则返回true，表示是树结构类型；否则返回false
     */
    public static boolean isTree(String tplCategory) {
        return tplCategory != null && StringUtils.equals(GenConstants.TPL_TREE, tplCategory);
    }

    /**
     * 判断当前对象是否为CRUD类型
     * <p>
     * CRUD类型通常指的是具有增（Create）、删（Delete）、改（Update）、查（Select）操作的数据库实体，
     * 这种类型的操作通常涉及数据库表的映射，用于进行数据的基本管理维护工作。
     * </p>
     *
     * @return 如果当前对象是CRUD类型，则返回true；否则返回false
     * @see #isCrud(String) 此方法调用了带有字符串参数的另一个isCrud方法，传递当前对象的tplCategory属性作为参数
     */
    public boolean isCrud() {
        return isCrud(this.tplCategory);
    }

    /**
     * 判断模板类别是否为CRUD操作相关
     *
     * 此方法用于验证传入的模板类别参数是否与系统预定义的CRUD操作类别常量相等
     * 它在生成代码模板时至关重要，确保模板类别正确无误地被识别为CRUD操作类型
     *
     * @param tplCategory 模板类别参数，用于标识特定类型的模板
     * @return 返回布尔值，如果模板类别与CRUD操作类别相匹配，则返回true，否则返回false
     */
    public static boolean isCrud(String tplCategory) {
        return tplCategory != null && StringUtils.equals(GenConstants.TPL_CRUD, tplCategory);
    }

    /**
     * 判断给定的Java字段是否为超级列
     * 超级列是指在特定的模板类别下具有特殊意义的列
     *
     * @param javaField 待检查的Java字段名称
     * @return 如果字段是超级列，则返回true；否则返回false
     */
    public boolean isSuperColumn(String javaField) {
        return isSuperColumn(this.tplCategory, javaField);
    }

    /**
     * 判断给定的字段是否为超级列
     * 超级列是指在特定的实体类别中不被视为普通字段的列，如通用实体类中的列
     * 这个方法主要用于排除在特定上下文中不需要或不适用的字段
     *
     * @param tplCategory 模板类别，用于区分不同类型的实体
     * @param javaField Java字段名称
     * @return 如果字段是超级列，则返回true；否则返回false
     */
    public static boolean isSuperColumn(String tplCategory, String javaField) {
        // 判断javaField是否是定义在GenConstants.BASE_ENTITY中的任意一个常量，忽略大小写
        return StringUtils.equalsAnyIgnoreCase(javaField, GenConstants.BASE_ENTITY);
    }
}
